R/gta hs vintage converter.R

In global-trade-alert/gtalibrary: Contains functions to work with GTA data

# Roxygen documentation

#' Convert HS codes of unkown vintage into HS 2012.
#'
#' Returns it as a vector of 6-digit level HS 2012 codes.
#'
#' @param codes Supply the HS codes you want to check. Values with 2 or more digits are allowed. Values with more than 6 digits will be limited to 6. Please input the codes as integer.
#' @param origin State the origin vintage, if you know it (options: '2002','2007','2012','2017','best', 'any'). Where 'best' selects the HS vintage with the most matches and 'any' selects HS codes from multiple origin vintages. Default is 'best'.
#'
#' @references www.globaltradealert.org
#' @author Global Trade Alert


gta_hs_vintage_converter=function(
  codes,
  origin="best"){


  codes=as.numeric(as.character(codes))

  # Load HS vintages
  hs.vintages= gtalibrary::hs.vintages

  if(! origin %in% c("best","any")){

    hs.vintages= subset(hs.vintages, origin.vintage==paste("HS ", origin, sep=""))
    codes.converted=unique(hs.vintages$hs.2012[hs.vintages$origin.code %in% codes])
    codes.unconverted=! codes %in% hs.vintages$origin.code

  }

  if(origin=="best"){
    hs.02= subset(hs.vintages, origin.vintage=="HS 2002")
    hs.07= subset(hs.vintages, origin.vintage=="HS 2007")
    hs.12= subset(hs.vintages, origin.vintage=="HS 2012")
    hs.17= subset(hs.vintages, origin.vintage=="HS 2017")
    hs.22= subset(hs.vintages, origin.vintage=="HS 2022")

    matches=c(length(intersect(codes, hs.02$origin.code)),
              length(intersect(codes, hs.07$origin.code)),
              length(intersect(codes, hs.12$origin.code)),
              length(intersect(codes, hs.17$origin.code)),
              length(intersect(codes, hs.22$origin.code)))

    use.hs=c(2002, 2007, 2012, 2017, 2022)[matches==max(matches)]

    hs.vintages= subset(hs.vintages, origin.vintage==paste("HS ", max(use.hs), sep=""))

    codes.converted=unique(hs.vintages$hs.2012[hs.vintages$origin.code %in% codes])
    codes.unconverted=codes[! codes %in% hs.vintages$origin.code]
  }

  if(origin=="any"){
    codes.converted=unique(hs.vintages$hs.2012[hs.vintages$origin.code %in% codes])
    codes.unconverted=codes[! codes %in% hs.vintages$origin.code]
  }


  if(length(codes.unconverted)>0){
    print(paste("Could not match the following codes: ",paste(codes.unconverted, collapse=", "), sep=""))
  } else {
    print("All supplied codes were matched.")
  }

  return(codes.converted)

}